home *** CD-ROM | disk | FTP | other *** search
/ CU Amiga Super CD-ROM 27 / CU Amiga Magazine's Super CD-ROM 27 (1998)(EMAP Images)(GB)[!][issue 1998-10].iso / CUCD / Programming / JForth / Textra120 / Docs / TextraScripts.doc < prev    next >
Encoding:
Text File  |  1996-11-02  |  11.6 KB  |  257 lines
  1.  
  2. This is a list of all the scripts that come with Textra 1.18,
  3. accompanied by a short description and an example of their use.
  4.  
  5. All scriptnames (minus the '.textra'), with or without arguments, 
  6. may be enetered in any of the 10 saveable string gadgets in the 
  7. ARexx requester.  8 of these are bound to a function key.
  8.  
  9. Textra will bind scripts named CTRLA.textra, CTRLB.textra, etc.
  10. to the appropriate CTRL-key combination.  Case-insensitive, up
  11. to 26 CTRL key combinations may be defined for chars A thru Z.
  12. of course, such scripts do not accept arguments in the normal
  13. sense, but can look at environment variables, files, etc.
  14.  
  15. A complete glossary of the 70+ available commands that make
  16. up the Textra-ARexx interface is included in the Textra package,
  17. (in the RexxCommand.doc file) as well as full documentation
  18. for all editor features (in the Textra.doc file).
  19.  
  20.  
  21. General Textra ARexx scripts
  22. ===========================================================================
  23. AddIcon.textra - With just a little setup work, this script can be
  24.                  used to create Workbench icons for your Textra files.
  25.                  Double-clicking on them opens the text file in Textra!
  26.  
  27. Art1.textra & Art2.textra - neat random-movement ascii
  28.               graphics... hard to believe it's a text editor!  Thanks to
  29.               Nick Didkovsky (saying thanks to Nick gets to be a habit!),
  30.               long-time JForth guru.
  31.  
  32. bol.textra - Moves the cursor to the beginning of the current line
  33.              (In Textra 1.15 and higher, 'column 0' is faster)
  34.              Usage:  bol
  35.              
  36. date.textra - Writes the current date at the cursor/select location
  37.               Usage:  date
  38.  
  39. DelToEnd.textra - Deletes from the current cursor/select to the
  40.                   end of the line (sounds ominous, eh?)
  41.                   Usage:  deltoend
  42.  
  43. DelToStart.textra - Deletes from the current cursor/select to the
  44.                     beginning of the line.
  45.                     Usage:  deltostart
  46.                     
  47. DelWholeLine.textra - Deletes the entire cursor/select line
  48.                       Usage:  delwholeline
  49.  
  50. DoubleSpace.textra - Adds a blank line between every line in the
  51.                      selected range
  52.                      Usage:  Doublespace
  53.  
  54. eol.textra - Moves the cursor to the end of the current line
  55.              (In Textra 1.15 and higher, 'column "-1"' is faster)
  56.              Usage:  eol
  57.              
  58. eval.textra - Select a mathematical expression, eval will calculate
  59.               it and display the answer, and even optionally insert
  60.               the answer in the text document at the current
  61.               cursor/select position!
  62.               Usage:  eval             (displays answer in requester)
  63.                       eval <anystring> (inserts answer in document)
  64.               
  65. Files.textra - Opens a window and presents a very informative
  66.                display of summary information for each open
  67.                Textra window (#lines, size in ram & on disk,
  68.                'changed' status, window position, more)
  69.                Usage:  files
  70.                
  71. Hello.textra - Simple example of text insertion and delay timing.
  72.                Usage:  hello
  73.                
  74. indent.textra - Similar to slide.textra, this script will also shift
  75.                 selected lines of text left or right, but uses TABs
  76.                 for the whitespace character (slide.textra uses
  77.                 BLANKs)  See scoot.textra and slide.textra.
  78.                 Usage:  indent 2       (shifts 2 TAB chars right)
  79.                         indent -2      (shifts 2 TAB chars left)
  80.                 
  81. InsertF.textra - recommend you assign this to a CTRL or F-
  82.                  key.  Then, enter & select the filename, then at the
  83.                  touch of that key, the file is inserted.
  84.    
  85. MarkAutodoc.textra - Open any standard Commodore autodoc file and
  86.                      let this script fly!  When done, there will
  87.                      be a defined MARK for every function described,
  88.                      allowing you to save the MARKS info permanently
  89.                      without changing the original autodoc file at all!
  90.                      Your autodoc-navigating problems are over.
  91.                      (without AmigaGuide and its overhead)
  92.                      Usage:  MarkAutoDoc
  93.                      
  94. paragraph.textra - Rendered largely obsolete by the Margins feature.
  95.                    Used for paragraph formatting, works on the selected
  96.                    lines, accepts 3 arguments:
  97.                    1. left margin of first line
  98.                    2. left margin of all following lines in selection
  99.                    3. right margin for all lines.
  100.                    Multiple paragraphs may be formatted, just put a
  101.                    blank line between each intended paragraph.
  102.                    Usage:  paragraph 12 8 68
  103.                    
  104. Scary.textra - Simple example of conditional branching and prompting
  105.                the user with a YES/NO question and waiting for the
  106.                answer. 
  107.                Usage:  scary
  108.                
  109. Scoot.textra - A very versatile script that really replaces both
  110.                slide.textra and indent.textra.  This one also shifts
  111.                blocks of text left and right, and can be told to use
  112.                EITHER TABs or BLANKs for whitespace!  It can also be
  113.                used to convert between the two (entab & reverse entab)
  114.                with no visible change.  The only disadvantage is that
  115.                it is slightly slower than either of its subsets (so
  116.                they remain in the package).
  117.                Usage:  scoot 0    (entabs)
  118.                        scoot 12
  119.                        scoot -2
  120.                
  121. ScootTest.textra - Can be used with scoot.textra for making sure a
  122.                    left-shift argument will not lose any characters by
  123.                    inadvertantly being too large.
  124.                    Usage:  scoot -2
  125.                    
  126. SingleSpace.textra - Removes all blank lines in the select range.
  127.                      Usage:  SingleSpace
  128.  
  129. Slide.textra - Similar to indent.textra, this script will also shift
  130.                selected lines of text left or right, but uses BLANKs
  131.                for the whitespace character (indent.textra uses
  132.                TABs)  Also see scoot.textra.
  133.                Usage:  slide 14
  134.                        slide -4
  135.                
  136. StartTextra.rexx - Not intended for use from textra, this script
  137.                    can be used by other applications as a convienient
  138.                    way to open Textra on a given file.
  139.                    Usage:  rx 'starttextra <filename>'
  140.                    
  141. TInfo.textra - Illustrates use of the Textra PREFS Arexx command, as well
  142.                as illustrating Textra's excellent error recovery when
  143.                an illegal argument is passed.
  144.                usage:  TInfo
  145.                
  146. Tutorial.textra - Self explanatory.
  147.                   Usage:  Tutorial
  148.  
  149. Unparagraph.textra - Used to convert the multi-lined paragraphs of a 
  150.                      simple text file into single-lines, suitable for 
  151.                      "Activate Margins..." using the "Line Breaks" 
  152.                      option.  Note that the input file should be 
  153.                      formatted such that an empty line follows each
  154.                      paragraph.  This script works on the existing
  155.                      select range.
  156.                      Usage:  unparagraph
  157.  
  158. WhereAmI.textra - Sample of reading/interpreting cursor or select position.
  159.                   Usage:  WhereAmI
  160.  
  161.  
  162. General C Language scripts
  163. ===========================================================================
  164. Box.textra - Select some lines and enter Box, all will be commented out
  165.              with an orderly box of '*' chars.
  166.              Usage:  box
  167.              
  168. MarkCFuncs.textra - Creates a defined MARK for all the functions in your
  169.                     C source file.
  170.                     Usage:  markcfuncs
  171.                     
  172. UnBox.textra - Removes the comment "box" created by box.textra.
  173.                Usage:  unbox
  174.  
  175.  
  176. Scripts to integrate with SAS/C
  177. ===========================================================================
  178. CTRLB.textra - Press CTRL-B to 'B'uild current project.  This is the easy 
  179.                way to restart the compiler after you have made changes to 
  180.                the source... even checks for the existence of a make file!
  181.                Usage:  ctrlb        (automatically bound to CTRL-B key)
  182.                
  183. CTRLF.textra - Press CTRL-F to 'F'ind current symbol.  Similar to the 
  184.                script provided with SE, this will allow you to place the 
  185.                cursor on a C symbol (such as 'strlen', et. al.), and GSTs 
  186.                will be searched for that symbol, with a new window popping 
  187.                up with the file that symbol is defined in if found.
  188.                Usage:  ctrlf        (automatically bound to CTRL-F key)
  189.  
  190. CTRLN.textra - Press CTRL-N to step to the 'N'ext compiler error/warning.
  191.                Usage:  ctrln        (automatically bound to CTRL-N key)
  192.  
  193. CTRLP.textra - Press CTRL-P to step to the 'P'revious compiler error/warning.
  194.                Usage:  ctrlp        (automatically bound to CTRL-P key)
  195.  
  196. SCMSG - Sample SAS/C compiler config file to tell SAS/C to use Textra.
  197.         Usage:  See SASC.readme in Textra package.
  198.  
  199.  
  200. Scripts to integrate with HS/Pascal
  201. ===========================================================================
  202. HScompile.textra - Invokes HS/Pascal to compile the selected file.
  203.                    Usage:  hscompile
  204.  
  205.  
  206. Scripts to integrate with JForth Professional
  207. ===========================================================================
  208. DeferStub.textra - This simple AREXX script is useful for assigning stub 
  209.                    words to deferred words in JForth source code.
  210.                    Usage:  DeferStub   (on selected text)
  211.  
  212. interpret.textra - Send the selected text to the JForth interpreter.
  213.                    Usage:  interpret
  214.  
  215. JCompile.textra - Tell JForth to compile the selected file.
  216.                   Usage:  JCompile
  217.  
  218. jfcomment.textra - Comment out the selected lines, or uncomment them if
  219.                    already commented out.
  220.                    Usage:  jfcomment
  221.                            jfcomment <comment char>
  222.  
  223. jFILE?.textra - Accepts the name of a JForth function, passes it to the
  224.                 JForth FILE? function.
  225.                 Usage:  jfile? <function name>
  226.  
  227. MarkColons.textra - Finds and MARKS all high-level definitions in a
  228.                     JForth source file (colon definitions)
  229.                     Usage:  markcolons
  230.  
  231. nextcolon.textra - Locates the next colon definition in the file, following
  232.                    the current cursor/select position.
  233.                    Usage:  nextcolon
  234.  
  235. Textra.f - JForth source file which must be compiled into your JForth
  236.            before you can use the view.textra or viewsel.textra scripts.
  237.            Usage:  compiled into JForth
  238.  
  239. tojf.textra - accepts a string and passes it to the JForth interpreter.
  240.               Usage:  tojf <the string>
  241.  
  242. view.textra - accepts the name of a JForth function name and opens the
  243.               souce file and locates the definition.  (JForth must
  244.               be running and listening to ARExx.  Also, see Textra.f).
  245.               Usage:  view <function name>
  246.  
  247. viewsel.textra - Considers the selected text to be a JForth function name 
  248.                  and opens the souce file and locates the definition.  
  249.                  (JForth must be running and listening to ARExx.  Also, see 
  250.                  Textra.f).
  251.                  Usage:  viewsel
  252.  
  253. zDotIf.textra - used to conditionally comment in-or-out the selected lines
  254.                 of source code by inserting/deleting pairs of "0 .IF" and
  255.                 ".THEN" statements.
  256.                 Usage:  zDotIf
  257.